/**
 * Copyright 2010 Jake Jackson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jake.nb.ext.ant.hints;

import java.util.Collection;
import org.netbeans.spi.editor.hints.ErrorDescription;

/**
 * Base interface for an ant editor hint. Implementors requiring the project cookie or the ant project must obtain
 * separately (via AntParser) and have to handle the exceptions properly. This is due to the fact, a build can contain
 * multiple errors which may lead to exceptions. These exception may creates an incompletely initialized project which
 * may prevents finding errors.
 * @author JakeJ
 */

// XXX: add a utility class providing all the spans, to avoid re-parsing by every hint
public interface AntHint {
  Collection<ErrorDescription> getErrors(final SpanContainer spanContainer);

  Configuration getConfiguration();
}
